/* 
 * Copyright 2001-2009 Terracotta, Inc. 
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 
 * use this file except in compliance with the License. You may obtain a copy 
 * of the License at 
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0 
 *   
 * Unless required by applicable law or agreed to in writing, software 
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 
 * License for the specific language governing permissions and limitations 
 * under the License.
 * 
 */

package org.go.expcetion;

import org.go.scheduler.Scheduler;

/**
 * An exception that can be thrown by a <code>{@link org.quartz.Job}</code>
 * to indicate to the Quartz <code>{@link Scheduler}</code> that an error
 * occurred while executing, and whether or not the <code>Job</code> requests
 * to be re-fired immediately (using the same <code>{@link JobExecutionContext}</code>,
 * or whether it wants to be unscheduled.
 * 
 * <p>
 * Note that if the flag for 'refire immediately' is set, the flags for
 * unscheduling the Job are ignored.
 * </p>
 * 
 * @see Job
 * @see JobExecutionContext
 * @see SchedulerException
 * 
 * @author hejie
 */
public class JobExecutionException extends WorkExecutionException {

	/**
	 * 
	 */
	private static final long serialVersionUID = 624008895639280813L;

	private boolean refire = false;

	private boolean unscheduleAllTriggs = false;

	private boolean unscheduleTrigg = false;

	/*
	 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	 * 
	 * Constructors.
	 * 
	 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	 */

	/**
	 * <p>
	 * Create a JobExcecutionException, with the 're-fire immediately' flag set
	 * to <code>false</code>.
	 * </p>
	 */
	public JobExecutionException() {
	}

	/**
	 * <p>
	 * Create a JobExcecutionException with the 're-fire immediately' flag set
	 * to the given value.
	 * </p>
	 */
	public JobExecutionException(boolean refireImmediately) {
		refire = refireImmediately;
	}

	/**
	 * <p>
	 * Create a JobExcecutionException, with the given message.
	 * </p>
	 */
	public JobExecutionException(String msg) {
		super(msg);
	}

	/**
	 * Create a JobExcecutionException with the given message and the 're-fire 
	 * immediately' flag set to the given value.
	 */
	public JobExecutionException(String msg, boolean refireImmediately) {
		super(msg);

		refire = refireImmediately;
	}

	/**
	 * <p>
	 * Create a JobExcecutionException with the given message, and underlying
	 * exception.
	 * </p>
	 */
	public JobExecutionException(String msg, Throwable cause) {
		super(msg, cause);
	}

	/**
	 * <p>
	 * Create a JobExcecutionException with the given message, and underlying
	 * exception, and the 're-fire immediately' flag set to the given value.
	 * </p>
	 */
	public JobExecutionException(String msg, Throwable cause, boolean refireImmediately) {
		super(msg, cause);

		refire = refireImmediately;
	}

	/**
	 * <p>
	 * Create a JobExcecutionException, with the given cause.
	 * </p>
	 */
	public JobExecutionException(Throwable cause) {
		super(cause);
	}

	/**
	 * <p>
	 * Create a JobExcecutionException with the given underlying exception, and
	 * the 're-fire immediately' flag set to the given value.
	 * </p>
	 */
	public JobExecutionException(Throwable cause, boolean refireImmediately) {
		super(cause);

		refire = refireImmediately;
	}

	/*
	 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	 * 
	 * Interface.
	 * 
	 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	 */

	@Override
	public boolean refireImmediately() {
		return refire;
	}

	@Override
	public void setRefireImmediately(boolean refire) {
		this.refire = refire;
	}

	@Override
	public void setUnscheduleAllTriggers(boolean unscheduleAllTriggs) {
		this.unscheduleAllTriggs = unscheduleAllTriggs;
	}

	@Override
	public void setUnscheduleFiringTrigger(boolean unscheduleTrigg) {
		this.unscheduleTrigg = unscheduleTrigg;
	}

	@Override
	public boolean unscheduleAllTriggers() {
		return unscheduleAllTriggs;
	}

	@Override
	public boolean unscheduleFiringTrigger() {
		return unscheduleTrigg;
	}

}
